home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 003 / db3util.arc / DB3UTIL.DOC next >
Encoding:
Text File  |  1986-11-02  |  9.9 KB  |  176 lines
  1.  
  2.  
  3.  
  4.                               D B 3 U T I L  v 1.0
  5.                                        by
  6.                                John Calvin Thames
  7.  
  8.          DB3UTIL is a utility program for dBase III programmers especially
  9.     those using WordTech's Quicksilver compiler.  The program provides four
  10.     basic functions:
  11.  
  12.          1. Lists all nonduplicate program, format, procedure, database,
  13.             index, memory, and report form files called in a dBase system
  14.             tree beginning with the specified file and all subsequent
  15.             files called.  Also reports on only a single file.  Reports
  16.             any files which were called and could not be found.  Lists to
  17.             either the screen or a printer.
  18.  
  19.          2. Provides a detailed analysis for each program in the system tree
  20.             (or one program only) of each program, format, procedure,
  21.             database, index, memory, and report form file called by that
  22.             program.  Also lists each database used and each index file used
  23.             by that database.  Reports on called files which could not be
  24.             found.
  25.  
  26.          3. Creates a list file for use with the Quicksilver compiler.
  27.             Includes files which have been changed since the last compile
  28.             date or a user specified date.  Saves time by eliminating the
  29.             recompilation of files which have not changed.
  30.  
  31.          4. Allows a global find and replace of strings with or without a
  32.             query in one file or all files in a system tree.  For example
  33.             this allows a mass change of a variable name throughout the
  34.             entire system of programs called by a root program.
  35.  
  36.          Typing dB3UTIL ? displays the help screen shown below.
  37.  
  38. ================================================================================
  39.  
  40.      dB3UTIL Usage : dB3UTIL <filename> [db3util switch] [date]
  41.  
  42.         <filename> : root, main program, or parent dBASE file with extension
  43.  
  44.   [db3util switch] : \A, \C, \L, \R, and \RQ of the following cannot be used
  45.                      together on a command line
  46.            [blank] = List files to screen
  47.                 \A = Print analysis of files
  48.                 \C = Create QUICKSILVER Compiler listfile
  49.          \D<drive> = Object-code files located on specified drive
  50.                 \F = 1st character of filename dropped to form object-code file
  51.                 \L = List files to printer
  52.                 \O = Analyze <filename> only
  53.  \R[<str1>:<str2>] = Find and replace (without query) <str1> with <str2>
  54. \RQ[<str1>:<str2>] = Find and replace (with query) <str1> with <str2>
  55.  
  56.             [date] : specifies file creation or change date (mm/dd/yyyy) for
  57.                      \C option.  [blank] defaults to last compile date.
  58.  
  59. ================================================================================
  60.  
  61.  
  62.  
  63.  
  64.  
  65.       <filename> = Identifies the program file on which the analysis begins.
  66.                    Usually this file will be the first file used when running a
  67.                    program.  Unless the \O option is selected, all subordinate
  68.                    files called by this program file will be analyzed.  The
  69.                    file extension (e.g. .PRG) must be included when specifying
  70.                    the file name.  A path can also be specified.  For example,
  71.                    dB3UTIL B:\ACCOUNT\INVOICE.PRG will change the active
  72.                    directory to B:\ACCOUNT.  At the conclusion of the program,
  73.                    control will be returned to the original directory.
  74.  
  75. <db3util switch> = This option switch selects the type of analysis to be 
  76.                    conducted.  The options \A, \C, \L, \R, and \RQ cannot
  77.                    be used together on the same command line.  If more than
  78.                    one is specified, the first option listed will be the
  79.                    command which is executed.
  80.  
  81.                    [blank] = If there are no options selected, the program
  82.                              default is to list to the screen all of the
  83.                              files by file type (program, format, database,
  84.                              etc.) found during the analysis.
  85.  
  86.                         \A = Prints to a printer an analysis of which files
  87.                              are used by each of the other files.  A list
  88.                              is printed of each database and the index file(s) 
  89.                              used by that database.  Also listed are any files 
  90.                              which are called and cannot found in the active
  91.                              directory.
  92.  
  93.                         \C = Creates a Quicksilver Compiler listfile.  This
  94.                              is an ASCII file which contains the names of the
  95.                              individual program or format files which are to
  96.                              be compiled.  This option is used in conjunction
  97.                              with the [date] specification.  If [date] is
  98.                              listed, all program files found during the
  99.                              dB3UTIL analysis which have file creation dates
  100.                              (as shown when listing a directory) on or after
  101.                              that [date] will be included in the listfile.  If
  102.                              no [date] is specified and a corresponding 
  103.                              object-code file exists (either in the active 
  104.                              directory or as indicated by the \D option), the
  105.                              date for each object-code file determines whether
  106.                              a file is included in the listfile.  If no [date]
  107.                              is specified and no corresponding object-code file
  108.                              is found, that file is included in the listfile.
  109.                              This options allows a recompilation only of files
  110.                              which have been changed since the last compilation.
  111.                              The listfile will be named <filename>.DBU where
  112.                              <filename> is the root file specified on the 
  113.                              command line when dB3UTIL is invoked.
  114.  
  115.                  \D<drive> = Identifies the <drive> location of existing object-
  116.                              code files.  This option is used in conjunction 
  117.                              with the \C option.
  118.  
  119.  
  120.  
  121.  
  122.  
  123.                         \F = Indicates if the first letter of the file name was
  124.                              dropped to form the object-code file.  By default
  125.                              Quicksilver creates an object-code file by adding
  126.                              the "@" character to the beginning of the compiled
  127.                              filename.  If the filename is eight characters
  128.                              long, the last character is dropped to form the
  129.                              object-code name.  An option with Quicksilver is
  130.                              to drop the first rather than the last letter 
  131.                              when forming the object-code filename.  The
  132.                              dB3UTIL \C option needs to know how the name was
  133.                              formed when it looks for the file creation date.
  134.  
  135.                         \L = Performs the same function as using no options
  136.                              (see [blank] above) except the list of files are
  137.                              sent to a printer rather than the screen.
  138.  
  139.                         \O = Analyses only the single <filename>.  This option
  140.                              does not analysis the files called by <filename>.
  141.  
  142.          \R[<str1>:<str2>] = Finds and replaces (without query) <str1> with 
  143.                              <str2>.  This allows a global replacement of a 
  144.                              string with any other string.  If used without
  145.                              the \O option, <str1> will be replaced in the
  146.                              specified file and all called files without
  147.                              waiting for confirmation.  The square brackets
  148.                              must be used as delimiters so that leading and
  149.                              trailing spaces can be included.  For example,
  150.                              [FOR:THE] is not the same as [ FOR : THE ].  The
  151.                              first combination would find every usage of FOR
  152.                              (in the word FORMAT for instance) whereas the
  153.                              second combination would find only the unique word
  154.                              FOR.  The replacement string <str2> does not have
  155.                              to be the same length as <str1>.  The string
  156.                              "INTERNATIONAL BUSINESS MACHINES" could replace the
  157.                              string "IBM".  However line lengths in excess of
  158.                              255 characters could be created which may cause
  159.                              problems with some text editors.
  160.  
  161.         \RQ[<str1>:<str2>] = Performs the same as the \R option except that
  162.                              a confirming query is presented prior to any
  163.                              string replacement.  For example the command
  164.                              \RQ[FOR:THE] will require following question
  165.                                      REPLACE FOR WITH THE? (Y/N)
  166.                              to be answered with a "Y" before a replacement
  167.                              takes place.  The program line containing the
  168.                              found <str1> will be displayed above the query.
  169.                              The \R and \RQ options can be used on any ASCII 
  170.                              file which ends each line with a carriage return 
  171.                              and a line feed.
  172.  
  173.                     [date] = Specifies the last file change or creation date
  174.                              for use with the \C option.  See \C above.
  175.  
  176.